<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Nabu-asr: Recipes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Nabu-asr
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Recipes </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>A recipe contains configuration files for training and testing models designed for a specific database. Nabu alleady contains several pre-designed recipes, but you can design your own recipes with little effort. A recipe contains the following configurations files:</p>
<ul>
<li>database.conf: This is the database configuration. For every set of data (training features, training text, testing features ...) it contains a section that specifies where to read and write the data in your file system and wich processors should be used to process the data. Every recipe contains a template for the database configuration, but because the pahs are different ofor each person this has to be completed. You can put the completed database configuation in database.conf (which will automatically be added to the gitignore)</li>
<li>processor configuration files: One or multiple files for the data processors that are used. The database confiuration will point to these processor confiurations. For example, a feature processor specifies the type of feature, the feature parameters (window length, numbe of filters, ...) etc. You can find more information about processors ../../nabu/processing/processors/README.md "here".</li>
<li>model.cfg: This is the model configuration. It specifies the model parameters (number of layers, units ...). The classifies configuration contains 3 sections:<ul>
<li>io: give names to the inputs and outputs of the model</li>
<li>encoder: the encoder configuration. The encoder encodes the input to a new representation.</li>
<li>decoder: the decoder configuration. The decoder decodes the encoder representation into the desired output. You can find more information about models ../../nabu/neuralnetworks/models/README.md "here".</li>
</ul>
</li>
<li>trainer.cfg: specifies the trainer parameters (learning rate, nuber of epochs, ...). This configuration also specifies which data should be used to train the model. It links io names defined in the model configuration to data sections defined in the database configuration. A trainer is used to train the model to minimize some loss function. You can find more information about trainers ../../nabu/neuralnetworks/trainers/README.md "here".</li>
<li>validation_evaluator.cfg: specifies the validator type and parameters, that will be used during training. It also specifies which data will be used to evaluate the model in the same way the trainer configuration does. An evaluator is used to evaluate the performance of a model. The validation evaluator is used during training to measure the performance at fixed intervals and adjusts the learning rate if necesarry. You can find more information about evaluators ../../nabu/neuralnetworks/evaluators/README.md "here"</li>
<li>test_evaluator.cfg: This is the configuartion for the evaluator to be used at test time (see validation_evaluator.cfg)</li>
<li>recognizer.cfg: The configuration for the recognizer to be used for decoding it contains similar fields as the evaluator configs.</li>
</ul>
<p>To create your own recipe, simply create a directory containing all of the mentioned configuation files. You can find template configuations in config/templates.</p>
<p>All the components in the recipe have default configurations. You can find these configurations in the directory where the component is implemented under the defaults directory. If a field is not defined in the configuration it will be filled in with the default value. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
